package xx.services.demo.inter;

import javax.ws.rs.FormParam;
import javax.ws.rs.PathParam;
import javax.ws.rs.QueryParam;

/**
 * demo预览单个实体服务接口
 * 
 * @Path (Constants.RESTFUL_ROOT_PATH + "/demo/view")
 * 
 * @author chenxiang 2010-12-20
 */
public interface IViewInterface
{
    /**
     * 新增一个视图demo。<br>
     * 
     * @POST
     * 
     * @param title-@FormParam("title")
     *            列表标题
     * @param container-@FormParam("container")
     *            容器，一般是一个div，如：<div class="container">${container}</div>
     * @param templet-@FormParam("templet")
     *            模板
     * @param demo-@FormParam("demo")
     *            demo实例
     * @param shape-@FormParam("shape")
     *            图片样子
     * @param description-@FormParam("description")
     *            描述
     * @param sign-@FormParam("sign")
     *            标志，从Entity继承过来的实体才有标志
     * @param clazz-@FormParam("clazz")
     *            对应的实体class名称，<br>
     *            如：评论列表对应comment，回复列表对应reply，文章列表、文档列表、相册列表等从Entity继承过来的都对应entity。<br>
     *            注：从Entity继承过来的必须通过sign来区分，其他的如回复reply的sign为0.
     * @return 新视图实体
     * @author chenxiang
     */
    public String add(@FormParam("title")
    String title, @FormParam("container")
    String container, @FormParam("templet")
    String templet, @FormParam("demo")
    String demo, @FormParam("shape")
    String shape, @FormParam("description")
    String description, @FormParam("sign")
    int sign, @FormParam("clazz")
    String clazz);

    /**
     * 删除视图demo。<br>
     * 
     * @DELETE
     * @Path ("/{view_id}")
     * 
     * @param viewId-@PathParam("view_id")
     *            View ID ，多个ID用“_”隔开
     * @return true-删除成功，string-其他删除失败（string就是失败原因）
     * @author chenxiang
     */
    public String delete(@PathParam("view_id")
    String viewId);

    /**
     * 获取视图列表。<br>
     * 
     * @GET
     * 
     * @param sign-@QueryParam("sign")
     *            sign标志，当sign小于0时获取全部
     * @param clazz-@QueryParam("clazz")
     *            视图对应的class名称，当clazz为null时表示获取全部
     * @return 视图实体列表
     * @author chenxiang
     */
    public String gets(@QueryParam("sign")
    int sign, @QueryParam("clazz")
    String clazz);

    /**
     * 获取一个视图demo。 <br>
     * 
     * @GET
     * @Path ("/{view_id}")
     * 
     * @param viewId-@PathParam("view_id")
     *            View ID
     * @return 视图实体
     * @author chenxiang
     */
    public String get(@PathParam("view_id")
    long viewId);

    /**
     * 修改一个视图demo。<br>
     * 
     * @PUT
     * @Path ("/{view_id}")
     * 
     * @param viewId-@PathParam("view_id")
     *            View ID
     * @param title-@FormParam("title")
     *            列表标题
     * @param container-@FormParam("container")
     *            容器，一般是一个div，如：<div class="container">${container}</div>
     * @param templet-@FormParam("templet")
     *            模板
     * @param demo-@FormParam("demo")
     *            demo实例
     * @param shape-@FormParam("shape")
     *            图片样子
     * @param description-@FormParam("description")
     *            描述
     * @param sign-@FormParam("sign")
     *            标志，从Entity继承过来的实体才有标志
     * @param clazz-@FormParam("clazz")
     *            对应的实体class名称，<br>
     *            如：评论列表对应comment，回复列表对应reply，文章列表、文档列表、相册列表等从Entity继承过来的都对应entity。<br>
     *            注：从Entity继承过来的必须通过sign来区分，其他的如回复reply的sign为0.
     * @return 新视图实体
     * @author chenxiang
     */
    public String update(@PathParam("view_id")
    long viewId, @FormParam("title")
    String title, @FormParam("container")
    String container, @FormParam("templet")
    String templet, @FormParam("demo")
    String demo, @FormParam("shape")
    String shape, @FormParam("description")
    String description, @FormParam("sign")
    int sign, @FormParam("clazz")
    String clazz);
}
